JAMSRESTAPI Web Service
JAMSRESTAPI Web Service

Uri: http://doc.jamsscheduler.com/

All Operations
GetABAP_GetJobNames
GetABAP_GetMatchingVariants
GetABAP_GetVariants
DeleteAgent_DeleteAgentById
Deletes an Agent object.
DeleteAgent_DeleteAgentByName
Deletes an Agent object.
GetAgent_GetAgentByID
Get the Agent with the specified agentID.
GetAgent_GetAgentPermissionsById
Check if the current user has the required access to Agent
GetAgent_GetAgentPlatforms
Get list of the available agent platforms
GetAgent_GetAgentReferencesById
Get the Agent References with the specified agentID.
GetAgent_GetAgentTypes
Get list of the available agent types
GetAgent_GetAllAgents
Gets a list of all agents
PostAgent_PostAgent
Creates a new Agent object.
PutAgent_PutAgent
Updates an existing Agent object or creates a new definition if it doesn't exist.
GetAppMenu_GetAppMenu
Get all AppMenuItems.
GetAppMenu_GetAppMenuForUser
Get all AppMenuItems for User
PutAppMenu_PutAppMenuUserPreference
Updates the App Menu User Preferences
GetAuditTrail_GetAuditTrail
Gets AuditTrail of JAMS object specified
GetAuthentication_GetAuthentication
Provides information about the authenticated user
PostAuthentication_Login
Login to the web server
GetBanner_GetEnvironmentTypes
GetBanner_GetJobParameterSets
GetBanner_GetJobs
GetBanner_GetMIMETypes
PostBatchQueue_BatchQueueAction
Executes a specific Action for a specified Batch Queue (ie. start and stop)
DeleteBatchQueue_DeleteBatchQueueById
Delete the batch queue definition by name.
DeleteBatchQueue_DeleteBatchQueueByName
Delete the batch queue definition by name.
GetBatchQueue_GetBatchQueueByID
Gets a batch queue definition by ID
GetBatchQueue_GetBatchQueuePermissionsById
Check if the current user has the required access to Batch Queue
GetBatchQueue_GetBatchQueueReferencesById
Get the BatchQueue References with the specified BatchQueueId.
GetBatchQueue_GetBatchQueues
Gets all batch queue definitions
PostBatchQueue_PostBatchQueue
Adds a new batch queue definition
PutBatchQueue_PutBatchQueue
Updates an existing batch queue
PostBatchQueue_StartBatchQueue
Start the Batch Queue
PostBatchQueue_StopBatchQueue
Stop the Batch Queue
DeleteCalendar_DeleteCalendar
Deletes a Calendar object.
DeleteCalendar_DeleteCalendar
Deletes a Calendar object.
GetCalendar_GetCalendarByID
Get the Calendar with the specified ID.
GetCalendar_GetCalendarPermissionsById
Check if the current user has the required access to Calendar
GetCalendar_GetCDateType
Gets a collection of all Calendars
PostCalendar_PostCalendar
Creates a new Calendar object.
PutCalendar_PutDateType
Updates an existing Calendar object or creates a new definition if it doesn't exist.
GetCertificate_GetCertificateRoot
Get the Root Certificate authority.
PutCertificate_PutCertificateAgentConnector
Request an Agent Connector Certificate.
PutCertificate_PutCertificateAgentListener
Request an Agent Listener Certificate.
GetCfg_GetConfiguration
Get the Configuration with the specified configName.
GetCfg_GetThemeConfiguration
Get the theme Configuration anonymously.
PutCfg_PutConfiguration
Updates an existing Cfg object or creates a new definition if it doesn't exist.
PostConnection_GetOracleConnectionStringProperties
PostConnection_OracleConnectionTest
PostConnection_ParseOracleConnection
DeleteConnectionStore_DeleteConnectionStoreById
Delete a connection store
DeleteConnectionStore_DeleteConnectionStoreByName
Delete a connection store
GetConnectionStore_Get
Get a list of connection stores
GetConnectionStore_GetConnectionStoreById
Get the Connection Store with the specified Id.
GetConnectionStore_GetConnectionStorePlatforms
Get list of the available connection store platforms
GetConnectionStore_GetConnectionStoreTypes
Get list of the available connection store types
PostConnectionStore_Post
Update Connection Store
PutConnectionStore_Put
Update Connection Store
DeleteCredential_DeleteCredentialById
Deletes a Credential object.
DeleteCredential_DeleteCredentialByName
Deletes a Credential object.
GetCredential_GetCredentialByID
Get the User with the specified ID.
GetCredential_GetCredentialPermissionsById
Check if the current user has the required access to Credential
GetCredential_GetCredentialReferencesById
Get the Credential References with the specified CredentialId.
GetCredential_GetCredentials
Gets a collection of all credentials
PostCredential_PostCredential
Creates a new Credential object.
PutCredential_PutCredential
Updates an existing Credential object or creates new definition if it doesn't exist.
PutCredential_PutGenerateKeys
Generates a new public/private key pair for this Credential.
PutCredential_PutGenerateKeysUsingFileContent
Generates a new public/private key pair using file content.
DeleteDate_DeleteDate
Deletes a Date object.
DeleteDate_DeleteDateById
Deletes a Date object.
GetDate_GetEvaluateDate
Evaluate a natural language date and return the date that it identifies.
GetDate_GetEvaluateDates
Evaluate a natural language date and return a list of dates that it identifies.
PostDate_PostDate
Create new Date and attach it to the specified DateType
PostDate_PostDateById
Create new Date and attach it to the specified DateType
PutDate_PutDate
Adds a date to an existing DateType or creates a new DateType if it doesn't exist.
PutDate_PutDateById
Adds a date to an existing DateType or creates a new DateType if it doesn't exist.
DeleteDateType_DeleteDateType
Deletes a DateType object.
DeleteDateType_DeleteDateType
Deletes a DateType object.
GetDateType_GetDateType
Gets a collection of all DateTypes
GetDateType_GetDateTypeByID
Get the DateType with the specified ID.
PostDateType_PostDateType
Creates a new DateType object.
PutDateType_PutDateType
Updates an existing DateType object or creates a new definition if it doesn't exist.
GetElement_GetElementTypeProperties
Get a collection of IElements with class and soft properties.
GetElement_GetElementTypeProperties
Retrieves properties of an element type
GetElement_GetElementTypes
Returns element types by an element of a specified JAMS definition
GetEntry_GetEntry
Gets entry information for all entries in the current schedule.
GetEntry_GetEntryByID
Gets Entry information with the specified ID
GetEntry_GetEntryLog
Gets log file as download or preview of first 512 kB.
GetEntry_GetEntryParameter
Gets parameter value for a given entry.
GetEntry_GetEntryParameters
Gets parameter list for a given entry.
PutEntry_PutEntryDelete
Delete the specified entry.
PutEntry_PutEntryHold
Holds an Entry with the specified ID, with the specified HoldEntry Audit Comment.
PutEntry_PutEntryParameter
Sets the value for the entry parameter associated to the JAMS entry.
PutEntry_PutEntryRelease
Releases a Entry with the specified ID to Run Again
PutEntry_PutEntryReschedule
Reschedules a JAMS entry.
PutEntry_PutEntryRestart
Restarts the specified entry.
PutEntry_PutEntryState
Sets the JobStatus and Icon of a specified entry.
PutEntry_PutEntryStatus
Sets the job status of the indicated JAMS entry.
GetEntryAuditTrail_GetEntryAuditTrails
Gets Entry Audit Trail.
GetEnumDefaultValues_GetEnumDefaultValues
Returns the default value of all enums.
GetFolder_CheckFolderAccess
Checks a JAMS Folder definition.
DeleteFolder_DeleteFolderById
Deletes a folder definition
DeleteFolder_DeleteFolderByName
Deletes a folder definition
GetFolder_GetFolderAuditTrailRevisions
Retrieve Audit Trail Revisions for a given JobID
GetFolder_GetFolderAuditTrailVersion
Retrieve Audit Trail Version for a given JobID
GetFolder_GetFolderDetailsById
Get full folder definition by ID
GetFolder_GetFolderDetailsByName
Get full folder definition by ID
GetFolder_GetFolderPermissionsById
Check if the current user has the required access to Folder
GetFolder_GetFolderReferencesById
Get the Folder References with the specified FolderId.
GetFolder_GetFoldersByParent
Gets all child folder definitions of selected folder by ID or Qualified Name. If no parameters are specified, then the root folder will be returned.
PostFolder_PostFolder
Adds a new folder definition
PutFolder_PutFolder
Updates an existing folder definition
PutFolder_ResetTriggers
Resets Folder's Triggers
GetHelp_GetHelp
GetHistory_GetHistory
Gets job execution history.
GetHistory_GetHistoryByJobId
Get History by JobID
GetHistory_GetHistoryByJobIdAndHistoryId
Gets job execution history.
GetHistory_GetHistoryOdata
Gets job execution history using OData filters.
GetHistory_GetJobLog
Gets log file as an attachment or preview of first 512 kB. Note - Services should be up for that test to pass.
GetHome_GetExploreJAMSMenuItems
Retrieves menu items used for exploring JAMS on the Welcome page.
GetJob_CheckJobAccess
Checks a JAMS Job definition.
DeleteJob_DeleteJobById
Deletes a Job by id.
DeleteJob_DeleteJobByName
Deletes a Job by name.
GetJob_GetJobAuditTrailRevisions
Retrieve Audit Trail Revisions for a given JobID
GetJob_GetJobAuditTrailVersion
Retrieve Audit Trail Version for a given JobID
GetJob_GetJobByID
Get the Job with the specified ID.
GetJob_GetJobByName
Get the Job with the specified name.
GetJob_GetJobDocumentationById
Get the Documentation for a given Job by name.
GetJob_GetJobDocumentationByName
Get the Documentation for a given Job by name.
GetJob_GetJobPermissionsById
Check to see if the caller has the specified access to the job with the specified id.
GetJob_GetJobReferencesById
Get the references to the job with the specified id.
GetJob_GetJobsByFolderID
Gets all jobs in the Folder with the specified ID
GetJob_GetJobsByFolderName
Gets Jobs in the Folder with the specified name
GetJob_GetJobSourceById
Get the Source for a given Job by ID.
GetJob_GetJobSourceByName
Get the Source for a given Job by name.
PostJob_PostJob
Creates a new Job object.
PutJob_PutJob
Updates an existing Job object or creates new definition if it doesn't exist.
PutJob_ResetTriggers
Resets Job's Triggers
GetJsSettings_GetJsSettings
DeleteMenu_DeleteMenuById
Deletes a Menu definition
DeleteMenu_DeleteMenuByName
Deletes a Menu definition
GetMenu_GetMenuById
Gets a menu definition by ID
GetMenu_GetMenus
Gets a list of all Menus
PostMenu_PostMenu
Adds a new Menu definition to JAMS
PutMenu_PutMenu
Modifies or Creates a new Menu definition
GetMethod_CheckMethodAccess
Check access to the given method
DeleteMethod_DeleteMethodById
Deletes a Method definition
DeleteMethod_DeleteMethodByName
Deletes a Method definition
GetMethod_GetMethodByID
Gets a method definition by ID
GetMethod_GetMethodReferencesById
Get the Method References with the specified MethodId.
GetMethod_GetMethods
Gets a list of all methods
PostMethod_PostMethod
Adds a new Method definition to JAMS
PutMethod_PutMethod
Modifies or Creates a new Method definition
DeleteNamedTime_DeleteNamedTime
Deletes a NamedTime definition
DeleteNamedTime_DeleteNamedTime
Deletes a NamedTime definition
GetNamedTime_GetNamedTimeByID
Gets a named time by id
GetNamedTime_GetNamedTimeReferencesById
Get the NamedTime References with the specified NamedTimeId.
GetNamedTime_GetNamedTimes
Gets a list of all NamedTimes
PostNamedTime_PostNamedTime
Creates a new NamedTime definition
PutNamedTime_PutDisableById
PutNamedTime_PutEnableById
PutNamedTime_PutEnableDisable
GetProcessChain_GetProcessChains
GetProjectedSchedule_GetProjectedSchedule
Pulls JAMS Projected Schedule through JAMS api
GetPropertyDefinition_GetPropertyDefinitions
Gets a collection of JAMS Property Definitions by Property Of
DeleteResource_DeleteResource
Delete the resource definition by name
GetResource_GetResource
Gets all resources
GetResource_GetResourceByID
Gets a resource by ID
GetResource_GetResourceByName
Gets a resource by name
GetResource_GetResourcePermissionsById
Check if the current user has the required access to Resource
GetResource_GetResourceReferencesById
Get the Resource References with the specified ResourceId.
PostResource_PostResource
Add a new resource definition
PutResource_PutResource
Updates an existing resource
PostResource_SetQuantityAvailable
Change the value of quantity available on a resource
PutSAP_AddIntercept
GetSAP_CheckConnection
PostSAP_CopyJob
DeleteSAP_Delete
GetSAP_GetChildJobs
GetSAP_GetExternalCommands
GetSAP_GetInterceptedJobs
GetSAP_GetJobDefinition
GetSAP_GetJobSteps
GetSAP_OutputDevice
PostSAP_QuerySAPJobs
PutSAP_RaiseEvent
PostSAP_StartJob
GetScheduler_IsActive
Checks if the scheduler is in active status
GetSearch_GetTypedSearchResults
GetSecurity_GetSecurity
Get security ACL of specified access object
GetSecurity_GetSecurityPermissionsBySecurityType
Check if the current user has the required access to Access Control types
PutSecurity_PutSecurity
Update security ACL of specified access object
GetSecurity_ValidateIdentifierExistence
Validate if the identifier exists
GetServer_Get
Get the server version, product and time offset
GetServer_GetServerStatusResult
Get JAMS server health check. similar to the desktop client engine light status.
GetService_GetExecutorConfig
Get the JAMS Executor Configuration.
GetService_GetExecutorOutgoing
Get the JAMS Executor Outgoing Certificate.
GetService_GetExecutorPrimary
Get the Primary JAMS Executor Configuration.
GetService_GetExecutorRoot
Get the Root Certificate Authority for the JAMS Executor.
GetService_GetExecutorSecondary
Get the Secondary JAMS Executor Configuration.
PostSQL_GetConnectionStringProperties
GetSQL_GetServers
GetSQL_GetSqlServerDatabaseList
GetSQL_GetStoredProcedureParameters
GetSQL_GetStoredProcedures
PostSQL_ParseConnectionString
PostSQL_TestConnection
GetSubmit_GetSubmitByID
Get the submit info for a Job with the specified ID
GetSubmit_GetSubmitByName
Get the submit information for a Job with the specified name.
PostSubmit_PostSubmit
Submit the job specified in the SubmitInfo object. Usually, you create the SubmitInfo object by calling GetSubmit which returns a SubmitInfo. You can then modify values in the SubmitInfo before calling PutSubmit.
PutSubmit_PutUpdateSubmitWithHistoryInfo
GetSubmitMenu_GetSubmitMenuById
Gets a submit menu.
GetSubmitMenu_GetSubmitMenuByName
Gets a submit menu.
GetSubmitMenu_GetSubmitMenuDefault
PostSupport_ContactSupport
Send the data to HelpSystems via a WebService
PostTag_FindById
Returns the Tag with the specified ID.
PostTag_FindByName
Returns the Tag with the specified name.
GetTag_GetTags
Gets a collection of Tags
GetTenant_GetTenant
GetTheme_GetTheme
GetTimeZone_GetTimeZoneById
Gets a specific timezone by Id
GetTimeZone_GetTimeZones
Gets a list of timezones
PostValidation_PostEmailAddressesValidationResult
Validate a collection of email address. Input will be an array of email address strings, output will be array of validation objects for each email address sent on request
PostVariable_ChangeVariableValue
Changes the value of a variable identified by name
DeleteVariable_DeleteVariableById
Deletes a variable definition
DeleteVariable_DeleteVariableByName
Deletes a variable definition
PutVariable_EncryptVariableValue
GetVariable_GetVariableByID
Get the Variable with the specified ID.
GetVariable_GetVariableByName
Get the Variable with the specified name.
GetVariable_GetVariablePermissionsById
Check if the current user has the required access to Variable
GetVariable_GetVariableReferencesById
Get the Variable References with the specified VariableId.
GetVariable_GetVariablesByFolderID
Gets a list of variables under the specified folder definition by ID
GetVariable_GetVariablesByFolderName
Gets a list of variables under the specified folder definition by Name
PostVariable_PostVariable
Creates a new variable definition
PutVariable_PutVariable
Update the Variable object.
Json Schemas